Skip to main content

Followup Women

Service: Followup (Women)

  1. Base URL:
    http://zm.irdresearch.org/mrest/womenFollowup

  1. Description
    The Women Follow-Up Service is designed to fetch the latest follow-up information regarding a woman’s health and vaccination status. This service is used to track the status of vaccinations, health check-ups, and other important follow-up visits for women enrolled in the ZM system.
    The service allows updates to data related to the following key areas:
  • Women

  • Women Analysis

  • Vaccination

  • Address

  • Contact Number

  • Identifier

    Through follow-up, the service ensures that information regarding a women's health, vaccination schedule, and other data points is kept updated. This ongoing data collection supports continuous healthcare interventions and monitoring.


  1. Request Format

    All requests must be sent using HTTP POST method.


  1. Response Format
  • Content-Type: application/json
  • Success Response: A 200 OK HTTP status code with the appropriate JSON response body.
  • Failure Response: A 200 OK HTTP status code with no JSON content, only a code value of 2 to indicate failure due to an incomplete operation or unknown reasons.
  • Server Error Response: A 500 Internal Server Error HTTP status code when a server-side error occurs.

  1. Dependencies

    The child follow-up API stores data into multiple tables in the system, including:

  • Women
  • Women Analysis
  • Vaccination
  • Address
  • Contact Number
  • Identifier

  1. Schema

    Below are the key entities utilized by the Follow-Up Service:

  2. Women

  3. Women Analysis

  4. Vaccination

  5. Address

  6. Contact Number

  7. Identifier

    This API documentation outlines the Follow-Up Service for women, detailing the request format, schema for key data entities, and expected response formats for success, failure, and error cases. The follow-up service plays a critical role in maintaining updated women health data within the system.


  1. Flow Chart

    Locale Dropdown